Change Advance Cycle

Change the cycle of the advance

Request
Security:
path Parameters
account_guid
required
string <uuid>
version
required
string
Request Body schema: application/json
period
integer <int32>

Value represented in the mob field of payment schedule found in retrieve account or advance precalc

cycle
string (AdvanceCycleType)
Enum: "BIWEEKLY" "SEMIMONTHLY" "MONTHLY"
Responses
201

Changes the cycle of the advance

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

post/api/{version}/advances/{account_guid}/cycle
Request samples
application/json
{
  • "period": 0,
  • "cycle": "BIWEEKLY"
}
Response samples
application/json
{
  • "advance_account_details": {
    • "account": {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "client_reference_id": "6970735e-7ed9-436b-b2f2-f25200dba6b0",
      • "start_date": "2019-08-24T14:15:22Z",
      • "limit": 0,
      • "outstanding_balance": 0,
      • "credit_product": "string",
      • "cycle": "string",
      • "status": "string",
      • "payment_summary": {
        • "outstanding_principal": 0,
        • "disbursement_amount": 0,
        • "processing_fees": 0,
        • "carriedbalance_fees": 0,
        • "total_repayment": 0,
        • "number_of_payments": 0
        },
      • "payment_schedule": [
        • {
          • "mob": 0,
          • "date": "2019-08-24T14:15:22Z",
          • "disbursement_principal": 0,
          • "disbursement_fee": 0,
          • "total": 0,
          • "fee": 0,
          • "principal": 0,
          • "balance": 0,
          • "paid_principal": 0,
          • "paid_interest": 0,
          • "available_balance": 0,
          • "cycle": "string",
          • "type": "string",
          • "status": "string"
          }
        ],
      • "available_date_range": [
        • {
          • "name": "string",
          • "date": "2019-08-24T14:15:22Z"
          }
        ]
      }
    }
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.